feat: [#521] User can custom recover when a request panic #103

KlassnayaAfrodita · 2024-11-15T20:06:59Z

📑 Description

Closes goravel/goravel#521

@coderabbitai summary

✅ Checks

Added test cases for my code

coderabbitai · 2024-11-15T20:07:05Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

🚀 Review Ready

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov-commenter · 2024-11-15T20:08:06Z

Codecov Report

Attention: Patch coverage is 82.60870% with 4 lines in your changes missing coverage. Please review.

Project coverage is 78.15%. Comparing base (5a68f28) to head (cdf7d2f).
Report is 53 commits behind head on master.

Files with missing lines	Patch %	Lines
route.go	78.57%	2 Missing and 1 partial ⚠️
facades/gin.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #103      +/-   ##
==========================================
- Coverage   79.29%   78.15%   -1.14%     
==========================================
  Files          12       16       +4     
  Lines         874     1158     +284     
==========================================
+ Hits          693      905     +212     
- Misses        151      211      +60     
- Partials       30       42      +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

context_request.go

context_request_test.go

facades/gin.go

middleware_timeout.go

route.go

hwbrzzl · 2024-11-16T08:34:51Z

route.go

 	}
 	middlewares = append(defaultMiddlewares, middlewares...)
 	r.setMiddlewares(middlewares)
 }

+func (r *Route) Recover(recoverFunc func(ctx *gin.Context, err interface{})) {
+    r.instance.Use(func(ctx *gin.Context) {


There is a CustomRecovery method in Gin, we can use it directly.

will we end up using gin.CustomRecovery?

If it can be used directly, yes, we can.

Is CustomRecovery suitable, please?

hwbrzzl · 2024-11-16T08:38:38Z

service_provider.go

@@ -35,13 +36,18 @@ func (receiver *ServiceProvider) Boot(app foundation.Application) {

 	if ConfigFacade = app.MakeConfig(); ConfigFacade == nil {
 		color.Errorln(errors.ConfigFacadeNotSet.SetModule(module))
+		shutdownOnCriticalError("ConfigFacade is not set")


I think it's unnecessary for now, we want to print a warning instead of interrupting.

Need to remove the function totally.

view.go

KlassnayaAfrodita · 2024-11-21T21:19:49Z

can you give me a direction to solve the error?

hwbrzzl

Pretty good now, could you add some test cases for the new logic?

hwbrzzl · 2024-12-20T02:25:39Z

context_request.go

@@ -44,11 +44,12 @@ func NewContextRequest(ctx *Context, log log.Log, validation contractsvalidate.V
 	request := contextRequestPool.Get().(*ContextRequest)
 	httpBody, err := getHttpBody(ctx)
 	if err != nil {
-		log.Error(fmt.Sprintf("%+v", err))
+        	LogFacade.Error(fmt.Sprintf("%+v", errors.Unwrap(err)))


Don't need to modify this, I optimized the code in a previous PR.

Please modify this

do I need to return log?
patch-3 of my fork currently uses LogFacade

log is fine, please update your branch.

facades/gin.go

route.go

service_provider.go

view.go

hwbrzzl

Great, please add some test cases for the new logic, then we can merge this.

hwbrzzl · 2024-12-24T01:02:14Z

context_request.go

@@ -44,11 +44,12 @@ func NewContextRequest(ctx *Context, log log.Log, validation contractsvalidate.V
 	request := contextRequestPool.Get().(*ContextRequest)
 	httpBody, err := getHttpBody(ctx)
 	if err != nil {
-		log.Error(fmt.Sprintf("%+v", err))
+        	LogFacade.Error(fmt.Sprintf("%+v", errors.Unwrap(err)))


Please modify this

KlassnayaAfrodita · 2024-12-24T13:38:38Z

Great, please add some test cases for the new logic, then we can merge this.

I wrote two tests for a custom function and a default one. I need to create a new test file or add to an existing one (for example route_test.go). for the default case you need to use route.Recover(nil)
I want to do route.Recover()
for this I want to add

func (r *Route) SetRecover(callback func(ctx context.Context, err any)){
    globalRecoverCallback = callback
}

hwbrzzl · 2024-12-24T15:02:23Z

You don't need to call route.Recover() when testing the default action.

KlassnayaAfrodita · 2024-12-24T18:21:09Z

#103 (comment)
do I need to return log?
patch-3 of my fork currently uses LogFacade

hwbrzzl · 2024-12-25T01:39:31Z

route_test.go

 	"github.com/gin-gonic/gin/render"
 	contractshttp "github.com/goravel/framework/contracts/http"
 	"github.com/goravel/framework/contracts/validation"
 	configmocks "github.com/goravel/framework/mocks/config"
 	"github.com/stretchr/testify/assert"
 )

+func TestRecoverWithCustomCallback(t *testing.T) {
+	mockConfig := &configmocks.Config{}


Suggested change

mockConfig := &configmocks.Config{}

mockConfig := configmocks.NewConfig(t)

hwbrzzl · 2024-12-25T01:44:12Z

route.go

+	}
+}
+
+func (r *Route) Recover(callback func(ctx context.Context, err any)) {


Sorry, mistake, should be:

Suggested change

func (r *Route) Recover(callback func(ctx context.Context, err any)) {

func (r *Route) Recover(callback func(ctx httpcontract.Context, err any)) {

Please modify https://github.com/goravel/framework/pull/723/files#diff-37b488415e77368d5640d20902b15e5603864dc8c5c1e715bc36e2a8510b81f8R19 synchronously.

hwbrzzl · 2024-12-25T01:45:07Z

middleware_timeout_test.go

Please add a test case to test the custom recover as well.

hwbrzzl · 2024-12-25T01:45:18Z

middleware_timeout.go

 		}()

 		select {
 		case <-done:
-		case <-ctx.Request().Origin().Context().Done():
-			if errors.Is(ctx.Request().Origin().Context().Err(), context.DeadlineExceeded) {
+		case <-timeoutCtx.Done():


hwbrzzl · 2024-12-25T01:46:03Z

route_test.go

 	"github.com/gin-gonic/gin/render"
 	contractshttp "github.com/goravel/framework/contracts/http"
 	"github.com/goravel/framework/contracts/validation"
 	configmocks "github.com/goravel/framework/mocks/config"
 	"github.com/stretchr/testify/assert"
 )

+func TestRecoverWithCustomCallback(t *testing.T) {


Please add a test case to test the default recover as well.

hwbrzzl · 2024-12-25T01:46:54Z

route_test.go

+	assert.Equal(t, http.StatusInternalServerError, w.Code)
+
+	mockConfig.AssertExpectations(t)
+}


The test case is pretty good.

hwbrzzl

Perfect, please create a fiber like this. 👍

hwbrzzl · 2024-12-26T08:49:09Z

And another information, we are going to release v1.15 next week. It would be great if we could complete this issue this week.

[Feature] User can custom recover when a request panic

e06c940

KlassnayaAfrodita requested a review from a team as a code owner November 15, 2024 20:06

KlassnayaAfrodita added 12 commits November 15, 2024 23:35

Update middleware_timeout.go

09245fe

Update route.go

5168d1e

Update middleware_timeout_test.go

32ee690

Update middleware_timeout_test.go

29d36ee

Update context_request.go

88daede

Update view.go

e82b340

Update gin.go

f3efb50

Update context_request_test.go

61b20aa

Update service_provider.go

a771bce

Update view.go

3b77bd0

Update gin.go

cc7a261

Update context_request_test.go

21125ef

hwbrzzl reviewed Nov 16, 2024

View reviewed changes

KlassnayaAfrodita added 10 commits November 18, 2024 20:08

Update context_request.go

f3c666a

Update context_request_test.go

adf6a8c

Update gin.go

0a3998c

Update middleware_timeout.go

d001e4d

Update middleware_timeout_test.go

28af043

Update route.go

b0a62cd

Update service_provider.go

59ae234

Update view.go

5745c8f

Update view.go

fae6fbe

Update route.go

98f64a5

KlassnayaAfrodita added 2 commits November 22, 2024 00:26

Update route.go

076581a

Update middleware_timeout.go

d5d8a93

KlassnayaAfrodita added 4 commits December 20, 2024 02:03

Update middleware_timeout_test.go

1c07943

Update middleware_timeout_test.go

f020930

Update view.go

a0b8834

Update view.go

47c53e7

hwbrzzl reviewed Dec 20, 2024

View reviewed changes

KlassnayaAfrodita added 5 commits December 24, 2024 01:58

Update gin.go

343d493

Update route.go

41d57a1

Update service_provider.go

057f865

Update view.go

4d82e79

Update route.go

e6fb55f

hwbrzzl reviewed Dec 24, 2024

View reviewed changes

KlassnayaAfrodita added 3 commits December 24, 2024 19:36

Update route_test.go

5df7701

Update route_test.go

aa56ca1

Update route.go

66e139e

hwbrzzl reviewed Dec 25, 2024

View reviewed changes

KlassnayaAfrodita added 7 commits December 26, 2024 03:43

Update route_test.go

46fc772

Update route_test.go

48144d5

Update route.go

72a5064

Update route.go

e7eef7b

Update route_test.go

ee526b3

Update route_test.go

4d7e660

Update middleware_timeout_test.go

5371bd7

hwbrzzl approved these changes Dec 26, 2024

View reviewed changes

Merge branch 'master' into patch-3

cdf7d2f

hwbrzzl merged commit 1cbcae6 into goravel:master Dec 27, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [#521] User can custom recover when a request panic #103

feat: [#521] User can custom recover when a request panic #103

KlassnayaAfrodita commented Nov 15, 2024 •

edited by hwbrzzl

Loading

coderabbitai bot commented Nov 15, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov-commenter commented Nov 15, 2024 •

edited

Loading

hwbrzzl Nov 16, 2024

KlassnayaAfrodita Nov 16, 2024

hwbrzzl Nov 17, 2024

hwbrzzl Nov 28, 2024

hwbrzzl Nov 16, 2024

hwbrzzl Nov 28, 2024

KlassnayaAfrodita commented Nov 21, 2024

hwbrzzl left a comment

hwbrzzl Dec 20, 2024

hwbrzzl Dec 24, 2024

KlassnayaAfrodita Dec 24, 2024

hwbrzzl Dec 25, 2024

hwbrzzl left a comment

hwbrzzl Dec 24, 2024

KlassnayaAfrodita commented Dec 24, 2024

hwbrzzl commented Dec 24, 2024

KlassnayaAfrodita commented Dec 24, 2024

hwbrzzl Dec 25, 2024

hwbrzzl Dec 25, 2024

hwbrzzl Dec 25, 2024

hwbrzzl Dec 25, 2024

hwbrzzl Dec 25, 2024

hwbrzzl Dec 25, 2024

hwbrzzl left a comment

hwbrzzl commented Dec 26, 2024

	mockConfig := &configmocks.Config{}
	mockConfig := configmocks.NewConfig(t)

	func (r *Route) Recover(callback func(ctx context.Context, err any)) {
	func (r *Route) Recover(callback func(ctx httpcontract.Context, err any)) {

feat: [#521] User can custom recover when a request panic #103

feat: [#521] User can custom recover when a request panic #103

Conversation

KlassnayaAfrodita commented Nov 15, 2024 • edited by hwbrzzl Loading

📑 Description

✅ Checks

coderabbitai bot commented Nov 15, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov-commenter commented Nov 15, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KlassnayaAfrodita commented Nov 21, 2024

hwbrzzl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hwbrzzl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KlassnayaAfrodita commented Dec 24, 2024

hwbrzzl commented Dec 24, 2024

KlassnayaAfrodita commented Dec 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hwbrzzl left a comment

Choose a reason for hiding this comment

hwbrzzl commented Dec 26, 2024

KlassnayaAfrodita commented Nov 15, 2024 •

edited by hwbrzzl

Loading

coderabbitai bot commented Nov 15, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov-commenter commented Nov 15, 2024 •

edited

Loading